You can generate your own documentation for HERACLES using DOXYGEN. You will need to have DOXYGEN installed. The html documentation is generated by simply running 'doxygen' in the 'doc' directory. It creates a directory called 'doxygen_docs' inside which you will have a directory called 'html'. The main file is 'index.html' to be opened in a web browser.

Precompiled documentation:

Quick guide:

To run the automatic test suite (requires python or IDL), just type './test.sh' in the 'bin' directory. If the code does not compile, you might need to set the environment variable 'HERACLES_ARCH' to one of 'INTEL', 'MACOSX' or 'PGF90' according to your architecture. The test script should compile the code and run a series of hydrodynamic, MHD, radiative transfer and gravity tests, displaying the results on screen. There is also a longer series of tests (full_test.sh) which writes the results in ps format to the 'test/figs' directory. The automatic tests are a very useful way to check that any modification made to the code has not broken other parts of the code. (Runtimes: test.sh: 5min ; full_test.sh: 1h)

To compile the code, use the 'Makefile' in the 'bin' directory. You should set the precompiler flags and the 'CASE' variable to what you need.

To create a new simulation: create a new directory in the 'case' directory with the name of your run. Create an initialisation file and a namelist (copy them from the automatic tests 'test/init' and 'test/nml' and modify them). Add any required routines or functions to the 'user_step' (called at every timestep) and 'user_output' files which are empty by default.

Set the precompiler flags in the 'Makefile' to what you need:
PARA  = 1 to use MPI
CON   = 1 to include thermal conduction
RAYO  = 1 to use M1/P1 radiative transfer
DIF   = 1 to use flux limited diffusion
GRA   = 1 to include gravity
SCALP = 1 to include a passive scalar field
MHD   = 1 to use MHD
HDF   = 1 to use HDF5